hallcurrent25.h File Reference

This file contains API for Hall Current 25 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
#include "spi_specifics.h"

Go to the source code of this file.

Data Structures
struct	hallcurrent25_t
	Hall Current 25 Click context object. More...
struct	hallcurrent25_cfg_t
	Hall Current 25 Click configuration object. More...

Macros
#define	HALLCURRENT25_INPUT_CHANNEL_VOUT   0
	Hall Current 25 input channel selection.
#define	HALLCURRENT25_INPUT_CHANNEL_VOC   1
#define	HALLCURRENT25_NUM_CONVERSIONS   200
	Hall Current 25 default ADC samples number for averaging.
#define	HALLCURRENT25_ADC_RESOLUTION   0x0FFF
	Hall Current 25 ADC setting.
#define	HALLCURRENT25_VREF_3V3   3.3
#define	HALLCURRENT25_VREF_5V   5.0
#define	HALLCURRENT25_VREF   HALLCURRENT25_VREF_3V3
#define	HALLCURRENT25_TIMEOUT_MS   2000
	Hall Current 25 timeout setting.
#define	HALLCURRENT25_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
	Data sample selection.
#define	HALLCURRENT25_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
#define	HALLCURRENT25_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	hallcurrent25_return_value_t { HALLCURRENT25_OK = 0 , HALLCURRENT25_ERROR = -1 }
	Hall Current 25 Click return value data. More...

Functions
void	hallcurrent25_cfg_setup (hallcurrent25_cfg_t *cfg)
	Hall Current 25 configuration object setup function.
err_t	hallcurrent25_init (hallcurrent25_t *ctx, hallcurrent25_cfg_t *cfg)
	Hall Current 25 initialization function.
err_t	hallcurrent25_read_raw_adc (hallcurrent25_t *ctx, uint8_t channel, uint16_t *raw_adc)
	Hall Current 25 read raw ADC value function.
err_t	hallcurrent25_read_voltage (hallcurrent25_t *ctx, uint8_t channel, float *voltage)
	Hall Current 25 read voltage level function.
err_t	hallcurrent25_read_voltage_avg (hallcurrent25_t *ctx, uint8_t channel, uint16_t num_conv, float *voltage_avg)
	Hall Current 25 read average voltage level function.
uint8_t	hallcurrent25_get_fault_pin (hallcurrent25_t *ctx)
	Hall Current 25 get FAULT pin function.
err_t	hallcurrent25_calib_offset (hallcurrent25_t *ctx)
	Hall Current 25 calib offset function.
err_t	hallcurrent25_calib_resolution (hallcurrent25_t *ctx, float calib_current)
	Hall Current 25 calib resolution function.
err_t	hallcurrent25_read_current (hallcurrent25_t *ctx, float *current)
	Hall Current 25 read current function.

Detailed Description

This file contains API for Hall Current 25 Click Driver.

Enumeration Type Documentation

hallcurrent25_return_value_t

enum hallcurrent25_return_value_t

Hall Current 25 Click return value data.

Predefined enum values for driver return values.

Enumerator
HALLCURRENT25_OK
HALLCURRENT25_ERROR